home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-07 / stub41.zip / STUB.DOC < prev    next >
Text File  |  1991-06-13  |  9KB  |  304 lines
  1.                AI-LANBIOS low level "stub" driver
  2.                Preliminary Documentation
  3.                ==================================
  4.                  (C) Copyright 1991 ARTISOFT Inc.
  5.                             ALL RIGHTS RESERVED
  6.  
  7.  
  8. Introduction
  9. ============
  10.  
  11. The STUB low level AI-LANBIOS driver is part of the AI-LANBIOS
  12. product.  The low level driver is supposed to interface directly to
  13. network hardware, however, the STUB driver interfaces to no
  14. hardware, thus providing a local-only AI-LANBIOS interface.
  15.  
  16. Running STUB
  17. ============
  18.  
  19. The STUB low level driver must be run before the AI-LANBIOS.  The
  20. STUB driver interfaces to the AI-LANBIOS using a DOS multiplex
  21. interrrupt number.  The default multiplex number is C7.  If you are
  22. only running one low level driver and one copy of AI-LANBIOS then
  23. you will not have to concern yourself with which multiplex number
  24. to assign.  Multiplex numbers 00 through BF are reserved for DOS
  25. use so you must use a multiplex number between C0 through FF. 
  26.  
  27. You must start a different invocation of the STUB driver if you
  28. plan to simulate multiple adapters.
  29.  
  30. The STUB low level driver program name is STUB.EXE.  The syntax for
  31. STUB is
  32.  
  33.      STUB[switches...] [ ; comment]
  34.  
  35. where [switches...] denotes zero or more optional command line
  36. switches.  Switches may be delimited by blanks or slashes (/).  If
  37. a switch takes a value, the switch must be followed by an equal
  38. sign (=) or a colon (:).  Some values may be hexidecimal numbers
  39. while other values may be decimal.  All switch values are range
  40. checked and illegal values produce errors.
  41.  
  42. You may place a comment on the command line by preceeding the
  43. comment with a semicolon (;).  You must preceed the comment
  44. character with a blank.
  45.  
  46. The following are valid switch formats:
  47.  
  48.      SWITCH
  49.      SWITCH:value
  50.      /SWITCH
  51.      /SWITCH=value
  52.      @file     
  53.      
  54.  
  55. The valid STUB switches are enumerated below.  The letters "ddd"
  56. denote a decimal number.  The letters "hh" denote a hexidecimal
  57. number.  Values enclosed in [] indicate default values if the
  58. switch is omitted.  Values after [] denote the valid range of the
  59. switch. 
  60.  
  61. ----------
  62. The switch
  63.  
  64.      @indirect-file
  65.  
  66. specifies that further switches are to be taken from an indirect
  67. file.  Any switches after @indirect-file will be discarded.  You
  68. may invoke indirect files from within indirect files as many times
  69. as you wish.
  70.  
  71. The indirect file should contain valid switches and may contain
  72. comment characters (;) at the beginning of each line or after
  73. switches. 
  74.  
  75. For example,
  76.  
  77.      STUB @setup
  78.  
  79. The file SETUP contains
  80.  
  81.      ; STUB AI-LANBIOS driver setup file
  82.      ;
  83.      packet_size=4096    ; Set to small packet size
  84.      verbose             ; Display verbose information
  85.  
  86. ----------
  87. The switch
  88.  
  89.      HELP or ?
  90.  
  91. displays information about the valid command line switches, but
  92. does not install the STUB driver.  For example,
  93.  
  94.      STUB/help
  95.      STUB ?
  96.  
  97. See the messages section for a detailed description of the HELP
  98. display output.
  99.  
  100. ----------
  101. The switch
  102.  
  103.      MPX=hh [C7] C0..FF
  104.  
  105. specifies the multiplex (MPX) interrupt number to use for
  106. communication to the high level AI-LANBIOS.  You will need to
  107. change this value only if the MPX number is in use by another
  108. application or low level driver. 
  109. ----------
  110. The switch
  111.  
  112.      PACKET_SIZE=dddd [65535] 512..65535
  113.  
  114. specifies the maximum size packet that the low level driver will
  115. report to the AI-LANBIOS.  Specifying a packet size smaller than
  116. the default has no effect other than to reduce the performance of
  117. the NETBIOS.
  118.  
  119. ----------
  120. The switch
  121.  
  122.      REMOVE
  123.  
  124. causes the STUB driver to remove itself from memory.
  125.  
  126.  
  127. ----------
  128. The switch
  129.  
  130.      VERBOSE
  131.  
  132. causes the STUB driver to be installed and detailed information
  133. about the configuration of the STUB driver to be displayed.  See
  134. the messages section for a detailed description of the verbose
  135. output. 
  136.  
  137. STUB messages
  138. =============
  139.  
  140. The STUB driver produces two types of messages: Informative and
  141. Error.  All error messages are preceeded by the text "ERROR:" and
  142. cause the STUB driver not to be installed. 
  143.  
  144.  
  145. --------
  146. MESSAGE:
  147.  
  148. AI-LANBIOS STUB driver V1.01 - (C) Copyright 1991 ARTISOFT Inc.
  149.  
  150. This message is displayed each time the low level driver is
  151. invoked.
  152.  
  153. --------
  154. MESSAGE:
  155.                    ---- STUB driver installed ----
  156.  
  157. This message is displayed after the low level driver is
  158. successfully installed. 
  159.  
  160. --------
  161. MESSAGE:
  162.                  ---- STUB driver NOT installed ----
  163.  
  164. This message is displayed if the low level driver is not installed. 
  165. The driver will not be installed if help information is displayed
  166. or an error occured. 
  167.  
  168. --------
  169. MESSAGE:
  170.             ---- STUB removed ----
  171.  
  172. This message is displayed when the low level driver has been successfully
  173. removed from memory using the REMOVE switch on the STUB command line.
  174.  
  175. --------
  176. MESSAGE:
  177.  
  178. Command line             /verbose 
  179. MPX interface number     C7             Bytes of memory used    
  180. 1888           
  181.  
  182. This message is displayed if the VERBOSE switch is specified.  The
  183. values displayed specify how the low level driver is configured.
  184.  
  185. --------
  186. MESSAGE:
  187.  
  188. Valid command line switches:
  189.    HELP
  190.    MPX=            range 00 to FF hex 
  191.    PACKET_SIZE=    range 512 to 65535 decimal
  192.    VERBOSE
  193.    ?
  194.    @               range 0 to 3000 byte file
  195.  
  196. This message is displayed when the HELP or ? switch is used.  Each
  197. valid switch is listed with the acceptable range of values (if any)
  198. and the base (hex or decimal) that the numbers must be entered in. 
  199. The acceptable file size range for indirect files (@) is also
  200. listed. 
  201.  
  202. The low level driver is not installed when this switch is used.
  203.  
  204. ------
  205. ERROR:   MPX number hh is already in use - Try another number
  206.  
  207. Meaning: Multiplex (MPX) interrupt number hh is being used by
  208. another application or low level driver.
  209.  
  210. Remedy:  Try another MPX number.
  211.  
  212. ------
  213. ERROR:   Illegal switch - ??????=nnnn
  214.  
  215. Meaning: The switch ??????=nnnn is not a recognized switch.
  216.  
  217. Remedy:  You may only specify legal switches on the command line.
  218.  
  219. ------
  220. ERROR:   Illegal character after switch name - ??????xnnnn
  221.  
  222. Meaning: The switch ?????? is followed by a character other than
  223. '=' or ':' or the switch does not take a value.
  224.  
  225. Remedy:  Only use the characters '=' or ':' to specify switch
  226. values and do not place characters after switches that do not take
  227. values.
  228.  
  229. ------
  230. ERROR:   Switch value not in range - ??????=nnnn
  231.          Valid range is ssss to eeee
  232. Meaning: The value nnnn is not in proper range.  The value ssss
  233.          represents the lowest acceptable value and the the value 
  234.          eeee represents the highest acceptable value.
  235.  
  236. Remedy:  Limit your range of values to the acceptable range.
  237.  
  238. ------
  239. ERROR:   Illegal digit in switch value - ??????=nnnn
  240.  
  241. Meaning: An illegal digit (character) was encountered in the
  242. numeric switch value. 
  243.  
  244. Remedy:  You must restrict numeric decimal values to the numbers
  245. 0-9.  You must restrict hexidecimal values to the numbers 0-9 and
  246. the letters A-F.
  247.  
  248. ------
  249. ERROR:   Cannot open indirect file - @file
  250.  
  251. Meaning: The file "file" cannot be opened as an indirect file.
  252.  
  253. Remedy:  The file must exist before it can be used as an indirect
  254. file.
  255.  
  256. ------
  257. ERROR:     Can't REMOVE -- AI-LANBIOS(R) still installed
  258.  
  259. Meaning: STUB cannot be removed from memory because the AI-LANBIOS(R) is
  260.      is still installed.
  261.  
  262. Remedy:  REMOVE the AI-LANBIOS(R) from memory before trying to remove the
  263.      STUB driver.
  264.  
  265. ------
  266. ERROR:     STUB is not loaded
  267.  
  268. Meaning: STUB cannot be removed from memory because it is not installed.
  269.  
  270. Remedy:  STUB must be installed before it can be removed from memory.
  271.  
  272. ------
  273. ERROR:     Installed STUB is different version
  274.  
  275. Meaning: The STUB driver that is installed is a different version than the
  276.      one trying to remove it.
  277.  
  278. Remedy:  Check to see that both versions match before attempting to remove.
  279.  
  280. ------
  281. ERROR:     Can't REMOVE -- STUB interrupts re-hooked
  282.  
  283. Meaning: The STUB driver cannot be removed from memory because one of it's
  284.      hooked interrupt vectors has been re-hooked by another program.
  285.  
  286. Remedy:  If possible, remove the program that has re-hooked one of STUB's
  287.      interrupt vectors.
  288.  
  289.  
  290. Testing STUB return code (error level)
  291. ======================================
  292.  
  293. You may test the STUB return code or error level in a batch file
  294. by using the IF ERRORLEVEL command.  The following error levels are
  295. returned:
  296.  
  297.      0    No error has encountered.  WD8003 driver installed
  298.      1    MPX number is in use
  299.      2    Switch error
  300.      3    Can't remove STUB from memory - not installed
  301.      4      Can't remove STUB from memory - different version installed
  302.      5    Can't remove STUB from memory - vectors rehooked
  303.      6      Can't remove STUB from memory - AILANBIO still installed
  304.